/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsrm.storage;

import java.util.Date;

import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.wsrm.WsrmSequencePolicies;
/** This interface encapsulates information pertaining to a sequence. These 
    include, 
    <br>(a) Its creation date
    <br>(b) Its Sequence Identifier and the addressing identifier 
    <br>(c) The addressing identifier associated with the sequence creation 
    request. The addressing identifier is different for different messages in 
    a sequence. But sequence creation requests and responses, acknowledgement 
    on the last message in a sequence, and finally the termination of a 
    sequence all carry the same addressing identifier.
    
    @author Shrideep Pallickara and Sangmi Lee
    $Date: 2005/07/29 22:41:30 $
    $Revision: 1.4 $
*/
public interface WsrmSequenceInfo {
  /** Retrieve the creation date for the sequence */
  public Date getCreationDate();
  
  
  /** Retrieve the sequence identifier. */
  public String getSequenceIdentifier();
  
  
  /** Retrieve the addressing identifier. More specifically this refers to the
      addressing identifier associated with the sequence creation request. The
      addressing identifier is different for different messages within a 
      sequence. But sequence creation requests and responses, acknowledgement 
      on the last message in a sequence, and finally the termination of a 
      sequence all carry the same addressing identifier. */
  public String getAddressingIdentifier(); 
 
  /** Returns the source of this sequence */
  public EndpointReferenceType getSource();

  /** Returns the destination of this sequence */
  public EndpointReferenceType getDestination();
  
  /** Checks if this node is the source of the sequence in question*/
  public boolean isSource();
  

  /** Checks if this node is the destination of the sequence in question */
  public boolean isDestination();

 
  /** Check if there is a policy attachment */
  public boolean hasWsrmSequencePolicies();
  
  /* Retrieve the policy attachment associated with the sequence */
  public WsrmSequencePolicies getWsrmSequencePolicies();
  
  
  /** Checks to see if there is <i>last</i> message number in a given 
      Sequence. It should be noted that the indication of last message is
      available <i>only</i> within the last message in a sequence. */
  public boolean hasLastMessageInfo();
  
  /** If we do have information regarding the last message of a sequence,
      proceed to retrieve it */
  public long getLastMessageNumber();
  
    
  /** Checks to see if the sequence has expired */
  public boolean isExpired();
  

  /** Checks to see if the sequence is timed out */
  public boolean isTimedOut();
  
  /** Retrieve the time associated with the last activity */  
  public long getTimeOfLastActivity();


  /** Retrieve the timeout timestamp */
  public long getTimeoutTimestamp();
  
  
  /** Check to see if the sequence is terminated */
  public boolean isTerminated();
  
  
  /** Retrieve the termination timestamp */
  public long getTerminationTimestamp();

  
  /** Get the reason for termination */
  public String getTerminationReason();

  /** Get a byte representation of the WsrmSequenceInfo */
  public byte[] getBytes();
}
